Vcenter Identity Providers Oauth2CreateSpec

The Vcenter Identity Providers Oauth2CreateSpec schema contains the information used to create an OAuth2 identity provider.

This schema was added in vSphere API 7.0.0.0.

JSON Example

{
    "auth_endpoint": "string",
    "token_endpoint": "string",
    "public_key_uri": "string",
    "client_id": "string",
    "client_secret": "string",
    "claim_map": {
        "claim_map": {
            "claim_map": [
                "string"
            ]
        }
    },
    "issuer": "string",
    "authentication_method": "string",
    "auth_query_params": {
        "auth_query_params": [
            "string"
        ]
    }
}

string As uri As uri

auth_endpoint

Required

Authentication/authorization endpoint of the provider

This property was added in vSphere API 7.0.0.0.

string As uri As uri

token_endpoint

Required

Token endpoint of the provider

This property was added in vSphere API 7.0.0.0.

string As uri As uri

public_key_uri

Required

Endpoint to retrieve the provider public key for validation

This property was added in vSphere API 7.0.0.0.

string

client_id

Required

Client identifier to connect to the provider

This property was added in vSphere API 7.0.0.0.

string

client_secret

Required

The secret shared between the client and the provider

This property was added in vSphere API 7.0.0.0.

object

claim_map

Required

The map used to transform an OAuth2 claim to a corresponding claim that vCenter Server understands. Currently only the key "perms" is supported. The key "perms" is used for mapping the "perms" claim of incoming JWT. The value is another map with an external group as the key and a vCenter Server group as value.

This property was added in vSphere API 7.0.0.0.

string

issuer

Required

The identity provider namespace. It is used to validate the issuer in the acquired OAuth2 token.

This property was added in vSphere API 7.0.0.0.

string

authentication_method

Required

Authentication method used by the provider

For more information see: Vcenter Identity Providers Oauth2AuthenticationMethod.

This property was added in vSphere API 7.0.0.0.

object

auth_query_params

Optional

key/value pairs that are to be appended to the authEndpoint request.

How to append to authEndpoint request: If the map is not empty, a "?" is added to the endpoint URL, and combination of each k and each string in the v is added with an "&" delimiter. Details:

If the value contains only one string, then the key is added with "k=v".
If the value is an empty list, then the key is added without a "=v".
If the value contains multiple strings, then the key is repeated in the query-string for each string in the value.

This property was added in vSphere API 7.0.0.0.

If missing or null, the map will be empty.